@ GNU AS assembler header file for ProgInfo
@ Written by DefMod (Dec  9 2012) on Sun Dec  9 15:50:29 2012
@ Jonathan Coxhead, jonathan@doves.demon.co.uk, 5 Sept 1995

@ OSLib---efficient, type-safe, transparent, extensible,
@ register-safe API coverage of RISC OS
@ 
@ Copyright (c) 1994-2012 Jonathan Coxhead and OSLib maintainers
@ 
@ Licence:
@ 
@    OSLib is free software; you can redistribute it and/or modify
@ it under the terms of the GNU General Public License as published by
@ the Free Software Foundation; either version 1, or (at your option)
@ any later version - and this with the following clarification and
@ special exception:
@ 
@    Linking this library statically or dynamically with other modules
@ is making a combined work based on this library. Thus, the terms
@ and conditions of the GNU General Public License cover the whole
@ combination.
@ 
@    As a special exception, the copyright holders of this library
@ give you permission to link this library with independent modules
@ to produce an executable, regardless of the license terms of these
@ independent modules, and to copy and distribute the resulting
@ executable under terms of your choice, provided that you also meet,
@ for each linked independent module, the terms and conditions of the
@ license of that module. An independent module is a module which is
@ not derived from or based on this library. If you modify this
@ library, you may extend this exception to your version of the library,
@ but you are not obliged to do so. If you do not wish to do so, delete
@ this exception statement from your version.
@ 
@    OSLib is distributed in the hope that it will be useful,
@ but WITHOUT ANY WARRANTY; without even the implied warranty of
@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@ GNU General Public License for more details.
@ 
@    You should have received a copy of the GNU General Public License
@ along with this programme; if not, write to the Free Software
@ Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, USA.

#ifndef ProgInfo_Hdr
#  define ProgInfo_Hdr

#  ifndef Get_Types
#    define Get_Types
#    include "oslib/Types.Hdr"
#  endif

#  ifndef Get_OS
#    define Get_OS
#    include "oslib/OS.Hdr"
#  endif

#  ifndef Get_Toolbox
#    define Get_Toolbox
#    include "oslib/Toolbox.Hdr"
#  endif

#  ifndef Get_Window
#    define Get_Window
#    include "oslib/Window.Hdr"
#  endif

@Symbols for constants
#  define Class_ProgInfo 0x82b40
#  define ProgInfo_GenerateAboutToBeShown 0x1
#  define ProgInfo_GenerateDialogueCompleted 0x2
#  define ProgInfo_IncludeLicenceType 0x4
#  define ProgInfo_IncludeWebPageButton 0x8
#  define ProgInfo_GenerateWebPageClicked 0x10
#  define ProgInfo_Name 0x82b400
#  define ProgInfo_Purpose 0x82b401
#  define ProgInfo_Author 0x82b402
#  define ProgInfo_LicenceType 0x82b403
#  define ProgInfo_Version 0x82b404
#  define ProgInfo_NameLabel 0x82b405
#  define ProgInfo_PurposeLabel 0x82b406
#  define ProgInfo_AuthorLabel 0x82b407
#  define ProgInfo_LicenceLabel 0x82b408
#  define ProgInfo_VersionLabel 0x82b409
#  define ProgInfo_WebSite 0x80b40a
#  define ProgInfo_LicencePublicDomain 0x0
#  define ProgInfo_LicenceSingleUser 0x1
#  define ProgInfo_LicenceSingleMachine 0x2
#  define ProgInfo_LicenceSite 0x3
#  define ProgInfo_LicenceNetwork 0x4
#  define ProgInfo_LicenceAuthority 0x5
#  define Action_ProgInfoAboutToBeShown 0x82b40
#  define Action_ProgInfoDialogueCompleted 0x82b41
#  define Action_ProgInfoLaunchWebPage 0x82b42
#  define Error_ProgInfoTasksActive 0x80b400
#  define Error_ProgInfoAllocFailed 0x80b401
#  define Error_ProgInfoShortBuffer 0x80b402
#  define Error_ProgInfoNoSuchTask 0x80b411
#  define Error_ProgInfoNoSuchMethod 0x80b412
#  define Error_ProgInfoNoSuchMiscOpMethod 0x80b413

@Symbols for structure offsets and sizes
        .struct 0
        .skip   Bits
ProgInfo_Flags                 : 

        .struct 0
        .skip   Int
ProgInfo_Licence               : 

        .struct 0
ProgInfo_Object_flags          : .skip   ProgInfo_Flags
ProgInfo_Object_title          : .skip   Toolbox_MsgReference
ProgInfo_Object_title_limit    : .skip   Int
ProgInfo_Object_purpose        : .skip   Toolbox_MsgReference
ProgInfo_Object_author         : .skip   Toolbox_MsgReference
ProgInfo_Object_licence_type   : .skip   ProgInfo_Licence
ProgInfo_Object_version        : .skip   Toolbox_MsgReference
ProgInfo_Object_alternative_window_name: .skip   Toolbox_StringReference
ProgInfo_Object_uri            : .skip   Toolbox_MsgReference
ProgInfo_Object_uri_action     : .skip   Bits
ProgInfo_Object                : 

        .struct 0
        Toolbox_ResourceFileObject_MEMBERS ProgInfo_ObjectTemplate
ProgInfo_ObjectTemplate_objectflags: .skip   ProgInfo_Flags
ProgInfo_ObjectTemplate_title  : .skip   Toolbox_MsgReference
ProgInfo_ObjectTemplate_title_limit: .skip   Int
ProgInfo_ObjectTemplate_purpose: .skip   Toolbox_MsgReference
ProgInfo_ObjectTemplate_author : .skip   Toolbox_MsgReference
ProgInfo_ObjectTemplate_licence_type: .skip   ProgInfo_Licence
ProgInfo_ObjectTemplate_prog_version: .skip   Toolbox_MsgReference
ProgInfo_ObjectTemplate_alternative_window_name: .skip   Toolbox_StringReference
ProgInfo_ObjectTemplate_uri    : .skip   Toolbox_MsgReference
ProgInfo_ObjectTemplate_uri_action: .skip   Bits
ProgInfo_ObjectTemplate        : 

        .struct 0
        .skip   Toolbox_Full
ProgInfo_Full                  : 

        .struct 0
ProgInfo_ActionAboutToBeShown_tag: .skip   Toolbox_PositionTag
ProgInfo_ActionAboutToBeShown_position: 
ProgInfo_ActionAboutToBeShown_position_top_left: .skip   OS_Coord
        .struct ProgInfo_ActionAboutToBeShown_position
ProgInfo_ActionAboutToBeShown_position_full: .skip   ProgInfo_Full
ProgInfo_ActionAboutToBeShown  : 

        .struct 0
        Toolbox_ActionHeader_MEMBERS ProgInfo_ActionAboutToBeShownBlock
ProgInfo_ActionAboutToBeShownBlock_tag: .skip   Toolbox_PositionTag
ProgInfo_ActionAboutToBeShownBlock_position: 
ProgInfo_ActionAboutToBeShownBlock_position_top_left: .skip   OS_Coord
        .struct ProgInfo_ActionAboutToBeShownBlock_position
ProgInfo_ActionAboutToBeShownBlock_position_full: .skip   ProgInfo_Full
ProgInfo_ActionAboutToBeShownBlock: 

        .struct 0
        .skip   Toolbox_ActionHeaderBase
ProgInfo_ActionDialogueCompletedBlock: 

        .struct 0
        .skip   Toolbox_ActionHeaderBase
ProgInfo_ActionLaunchWebPageBlock: 


@Symbols for SWI's and SWI reason codes
.set XProgInfo_ClassSWI,0xa2b40
.set ProgInfo_ClassSWI,0x82b40

.set XProgInfo_PostFilter,0xa2b41
.set ProgInfo_PostFilter,0x82b41

.set XProgInfo_PreFilter,0xa2b42
.set ProgInfo_PreFilter,0x82b42

#  define ProgInfo_GetWindowID 0x0
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &0
   @Exit
   @  R0 = window (Toolbox_O)

#  define ProgInfo_SetVersion 0x1
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &1
   @  R3 -> version (String)

#  define ProgInfo_GetVersion 0x2
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &2
   @  R3 = buffer (pointer to String)
   @  R4 = size (Int)
   @Exit
   @  R4 = used (Int)

#  define ProgInfo_SetLicenceType 0x3
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &3
   @  R3 = licence_type (ProgInfo_Licence)

#  define ProgInfo_GetLicenceType 0x4
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &4
   @Exit
   @  R0 = licence_type (ProgInfo_Licence)

#  define ProgInfo_SetTitle 0x5
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &5
   @  R3 -> title (String)

#  define ProgInfo_GetTitle 0x6
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &6
   @  R3 = buffer (pointer to String)
   @  R4 = size (Int)
   @Exit
   @  R4 = used (Int)

#  define ProgInfo_SetURI 0x7
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &7
   @  R3 -> uri (String)

#  define ProgInfo_GetURI 0x8
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &8
   @  R3 = buffer (pointer to String)
   @  R4 = size (Int)
   @Exit
   @  R4 = used (Int)

#  define ProgInfo_GetWebEvent 0x9
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &9
   @Exit
   @  R0 = action (Bits)

#  define ProgInfo_SetWebEvent 0xa
   @Entry
   @  R0 = flags (Bits)
   @  R1 = prog_info (Toolbox_O)
   @  R2 = &A
   @  R3 = action (Bits)

#endif
